Skip to content

docs: improve README with navigation links, quick start guide, and migrate deployment docs to website#276

Merged
lexburner merged 1 commit intohigress-group:mainfrom
lexburner:docs/improve-readme-and-migrate-deployment-docs
Apr 17, 2026
Merged

docs: improve README with navigation links, quick start guide, and migrate deployment docs to website#276
lexburner merged 1 commit intohigress-group:mainfrom
lexburner:docs/improve-readme-and-migrate-deployment-docs

Conversation

@lexburner
Copy link
Copy Markdown
Contributor

📝 Description

  • 在 README.md 和 README_zh.md 顶部添加官网、文档、部署、贡献指南的导航链接
  • 优化快速开始部分,使用 make run 替代手动 java 命令,引导配置 ~/.env 环境变量
  • 新增 Worker 市场功能描述到核心能力表格
  • 新增 HiMarket 价值主张段落,说明企业 AI 规模化部署面临的挑战
  • 将部署文档链接从本地 deploy/DEPLOYMENT.md 迁移到线上文档站 higress.io
  • 删除本地 deploy/DEPLOYMENT.md 和 deploy/DEPLOYMENT_zh.md(内容已迁移至官网)
  • 移除 README 底部独立的文档章节(链接已整合到顶部导航)

✅ Type of Change

  • Documentation update

🧪 Testing

  • Manual testing completed
  • All tests pass locally

📋 Checklist

  • Code is self-reviewed
  • Documentation updated (if applicable)
  • No breaking changes (or migration guide provided)
  • All CI checks pass

@lexburner lexburner merged commit d25b05b into higress-group:main Apr 17, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant